Add missing doc for mtk_locus, transform rptdigits, globalsat options, etc.
authorRobert Lipe <robertlipe@gpsbabel.org>
Mon, 29 Feb 2016 00:05:24 +0000 (18:05 -0600)
committerRobert Lipe <robertlipe@gpsbabel.org>
Mon, 29 Feb 2016 00:05:24 +0000 (18:05 -0600)
xmldoc/filters/options/transform-rptdigits.xml [new file with mode: 0644]
xmldoc/formats/mtk_locus.xml [new file with mode: 0644]
xmldoc/formats/options/garmin_gpi-writecodec.xml [new file with mode: 0644]
xmldoc/formats/options/globalsat-dump-file.xml [new file with mode: 0644]
xmldoc/formats/options/globalsat-input-is-dump-file.xml [new file with mode: 0644]
xmldoc/formats/options/globalsat-showlist.xml [new file with mode: 0644]
xmldoc/formats/options/globalsat-track.xml [new file with mode: 0644]
xmldoc/formats/options/gpx-split.xml [new file with mode: 0644]

diff --git a/xmldoc/filters/options/transform-rptdigits.xml b/xmldoc/filters/options/transform-rptdigits.xml
new file mode 100644 (file)
index 0000000..e6feb75
--- /dev/null
@@ -0,0 +1,13 @@
+<para>
+This option lets you configure how many digits GPSBabel uses for numbering generated route point names.
+</para>
+<para>
+When GPSBabel creates route points during the transformation process these points are sequentially numbered and named "RPTxxx" where xxx represent the number. By default GPSBabel uses 3 digits for these numbers. Rationale: This way a large number of route points can be uniquely named while the generated names are limited to 6 characters. This limitation is imposed by specific GPS-devices.
+</para>
+<para>
+Using this option GPSBabel can be configured to use less or more digits for the generated names. This option is best used in conjunction with the rptname option.
+</para>
+<example id="transform_rptdigits">
+<title>Convert a GPX track to a GPX route, deleting the original track, using 2 digits for the generated numbers.</title>
+<para><userinput>gpsbabel -i gpx -f track.gpx -x transform,wpt=trk,del,rptdigits=2 -o gpx -F route.gpx</userinput></para>
+</example>
diff --git a/xmldoc/formats/mtk_locus.xml b/xmldoc/formats/mtk_locus.xml
new file mode 100644 (file)
index 0000000..48ff78d
--- /dev/null
@@ -0,0 +1,12 @@
+<para>
+This format is a protocol supports the MediaTek MT3339, a GPS 
+chipset that shipped around 2011 that has internal logging capability.  
+It is the 
+core of at least two GPS modules, including the 
+GlobalTop PA6H and the Fastrax IT530.  The GlobalTop PA6H module is in
+turn the heart of the Adafruit "Ultimate" GPS breakout board, popular
+in the Arduino "maker" world.
+</para>
+<para>
+It is similar to the mtk and mtk-bin formats for earlier Mediatek parts.
+</para>
diff --git a/xmldoc/formats/options/garmin_gpi-writecodec.xml b/xmldoc/formats/options/garmin_gpi-writecodec.xml
new file mode 100644 (file)
index 0000000..d0c549d
--- /dev/null
@@ -0,0 +1,6 @@
+<para>
+This lets you overwride the default codec of 'windows-1252' when writing
+strings in Garmin GPI files. This option may be removed in future versions
+of GPSBabel as it's not known which Garmin devices support which character
+sets.
+</para>
diff --git a/xmldoc/formats/options/globalsat-dump-file.xml b/xmldoc/formats/options/globalsat-dump-file.xml
new file mode 100644 (file)
index 0000000..419e043
--- /dev/null
@@ -0,0 +1,19 @@
+<para>
+The dump-file option is primarly for debugging is module. It lets you
+provide a file which contains the raw stream of bytes coming from the
+device. This is useful for capturing device state to describe to a 
+developer that can't actually access hte physical device as well as mocking
+the entire device for automated regression testing.
+</para>
+<para>
+<screen>
+<command>gpsbabel</command> 
+-i glboalsat,dump-file=<replaceable>gh625xt.bin</replaceable> -f <replaceable>/dev/ttyUSB0</replaceable>
+</screen>
+can be used to read the device and store its state in the file <filename>gh625xt.bin</filename>.  That file can then be distributed and someone else can
+read it with a command line:
+<screen>
+<command> gpsbabel</command> 
+-i globalsat,input-is-dump-file=1 -f <replaceable>gh625xt.bin</replaceable> -o gpx -F <replaceable>test.gpx</replaceable>
+</screen>
+</para>
diff --git a/xmldoc/formats/options/globalsat-input-is-dump-file.xml b/xmldoc/formats/options/globalsat-input-is-dump-file.xml
new file mode 100644 (file)
index 0000000..e29ce4f
--- /dev/null
@@ -0,0 +1,4 @@
+<para>
+This is the companion to dump-file and is used to tell the reader that
+the code is talking to a stored file and not physical hardware.
+</para>
diff --git a/xmldoc/formats/options/globalsat-showlist.xml b/xmldoc/formats/options/globalsat-showlist.xml
new file mode 100644 (file)
index 0000000..5da7914
--- /dev/null
@@ -0,0 +1,9 @@
+<para>
+The showlist argment displays the list of tracks stored on the device.
+</para>
+<example id="globalsat-option-showlist">
+  <title>Command showing list of tracks on device</title>
+  <para>
+    <userinput>gpsbabel -i globalsat,showlist=1 -f /dev/ttyUSB0</userinput>
+  </para>
+</example>
diff --git a/xmldoc/formats/options/globalsat-track.xml b/xmldoc/formats/options/globalsat-track.xml
new file mode 100644 (file)
index 0000000..c7af153
--- /dev/null
@@ -0,0 +1,9 @@
+<para>
+The 'track' option is used to fetch a single named track, probably one you
+learned about via the 'showlist' option from a previous invocation, instead
+of fetching all the tracks, which is our default.
+</para>
+<example id="globalsat-option-track">
+  <title>Command track can be used to fetch a single track, defult is all tracks</title>
+  <para><userinput>gpsbabel -i globalsat,track=number -f /dev/ttyUSB0 -o gpx,garminextensions -F outfile.gpx</userinput></para>
+</example>
diff --git a/xmldoc/formats/options/gpx-split.xml b/xmldoc/formats/options/gpx-split.xml
new file mode 100644 (file)
index 0000000..8b13789
--- /dev/null
@@ -0,0 +1 @@
+